Skip to content

docs: add ClickHouse environment variables and Docker Compose #2610

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Closed
wants to merge 1 commit into from
Closed

docs: add ClickHouse environment variables and Docker Compose #2610

wants to merge 1 commit into from

Conversation

@LeoKaynan
Copy link
Contributor

@LeoKaynan LeoKaynan commented Oct 16, 2025 •
edited
Loading

Description

Updates the v4 migration guide to document the ClickHouse requirement.

Changes

  • Added a new "ClickHouse" section to the breaking changes
  • Documented that v4 now uses ClickHouse by default for storing run traces and analytics data
  • Listed all required environment variables for ClickHouse configuration:
    • CLICKHOUSE_URL
    • CLICKHOUSE_LOG_LEVEL
    • RUN_REPLICATION_ENABLED
    • RUN_REPLICATION_CLICKHOUSE_URL
    • RUN_REPLICATION_LOG_LEVEL
  • Added instructions for Docker Compose users to update their configuration
  • Linked to the complete docker-compose.yml example on GitHub

Why

Users migrating from v3 to v4 need to know that ClickHouse is now dependency and how to configure it properly, especially when self-hosting or using Docker Compose.

✅ Checklist

  • I have followed every step in the contributing guide
  • The PR title follows the convention.
  • I ran and tested the code works

Testing

NO

Changelog

NO

Screenshots

Screenshot 2025-10-16 at 15 18 11

💯

@changeset-bot
Copy link

changeset-bot bot commented Oct 16, 2025 •
edited
Loading

⚠️ No Changeset found

Latest commit: e62fd56

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Oct 16, 2025 •
edited
Loading

Walkthrough

A ClickHouse subsection was added to docs/migrating-from-v3.mdx under the OpenTelemetry/BatchTrigger migration area. It documents that V4 uses ClickHouse by default for storing run traces and analytics, provides Docker Compose guidance, lists environment variables (CLICKHOUSE_URL, CLICKHOUSE_LOG_LEVEL, RUN_REPLICATION_ENABLED, RUN_REPLICATION_CLICKHOUSE_URL, RUN_REPLICATION_LOG_LEVEL), and includes sample configuration. The existing OpenTelemetry section remains with updated package version notes.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~5 minutes

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)
Check name Status Explanation
Title Check ✅ Passed The PR title "docs: add ClickHouse environment variables and Docker Compose" is directly related to the main changes in the changeset. It clearly identifies that this is a documentation update and highlights the two key components being added: ClickHouse environment variables and Docker Compose guidance. The title is concise, specific, and accurately summarizes the primary purpose of the changes without unnecessary verbosity or vague language.
Docstring Coverage ✅ Passed No functions found in the changes. Docstring coverage check skipped.
Description Check ✅ Passed The pull request description provides a clear and comprehensive overview of the changes being made to the v4 migration guide documentation. It includes a detailed description section, a well-organized list of changes with specific environment variables documented, and the rationale for the update. The author completed two of three checklist items and provided a screenshot. However, the description deviates from the template in several ways: the required "Closes #" reference is missing, the Testing section is minimal (just "NO" without explanation), the Changelog section is also minimal, and the third checklist item is not marked as completed. While these are present in the template structure, their content is sparse or absent.
✨ Finishing touches
  • 📝 Generate docstrings
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@LeoKaynan LeoKaynan force-pushed the docs/clickhouse-migration-v4 branch from d740b0a to e62fd56 Compare October 16, 2025 18:26
@LeoKaynan LeoKaynan closed this Oct 17, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

1 participant

@LeoKaynan